Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Windows installation #71

Closed
wants to merge 2 commits into from

Conversation

mabelzhang
Copy link
Contributor

Partially addresses gazebosim/docs#117

Made headings and code blocks consistent with other per-package installation tutorials.

One of the dependencies, libignition-rendering, is not yet on conda-forge and needs to be installed from source.
libignition-sensors is also not on conda-forge, so we don't have binary install instructions for Windows in this PR.
Both libraries need to be added to conda-forge.

Signed-off-by: Mabel Zhang <[email protected]>
@mabelzhang mabelzhang requested a review from iche033 as a code owner December 24, 2020 15:00
@mabelzhang mabelzhang added the Windows Windows support label Dec 24, 2020
@github-actions github-actions bot added the 🔮 dome Ignition Dome label Dec 24, 2020
@codecov
Copy link

codecov bot commented Dec 24, 2020

Codecov Report

Merging #71 (69da1ca) into ign-sensors4 (e67b3a3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff              @@
##           ign-sensors4      #71   +/-   ##
=============================================
  Coverage         76.01%   76.01%           
=============================================
  Files                23       23           
  Lines              2322     2322           
=============================================
  Hits               1765     1765           
  Misses              557      557           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e67b3a3...69da1ca. Read the comment docs.

Signed-off-by: Mabel Zhang <[email protected]>
@chapulina chapulina added the documentation Improvements or additions to documentation label Dec 28, 2020
Copy link

@JShep1 JShep1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I agree with the usage of cmake for building, it just feels a little over-complicated to have to manually specify the prefix path so that it can be linked. For sake of consistency among tutorials, I think it's good to use cmake, perhaps we could just a note to optionally use colcon on this one since a beginning user (and maybe even more advanced) may have difficult finding the correct path to link.

Install Ignition dependencies, replacing `<#>` with the desired versions:

```
conda install libignition-cmake<#> libignition-common<#> libignition-math<#> libignition-transport<#> libignition-msgs<#> libignition-plugin<#> --channel conda-forge
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, do we need to install libsdformat?

@JShep1 JShep1 mentioned this pull request Jan 20, 2021
@JShep1
Copy link

JShep1 commented Jan 20, 2021

Closing to retarget to Citadel. #82

@JShep1 JShep1 closed this Jan 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🔮 dome Ignition Dome Windows Windows support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants